# Up and running
The code consists of two files that can be run from any program capable of running a Jupyter Notebook. We recommend Anaconda or Google Collab, however the web scraper portion must run locally.
The cells necessary for each program contain a comment indicating whether if a cell must be run and how many times, is optional, is used to debug, or is obsolete and was kept for archival purposes
For the web scraper to function correctly, a window of FireFox must be running and visible in an adjacent window.
For the Data science portion, there are two modes. The first, verification mode, must be run first and requires five (5) years worth of data and it goes back a year and runs against a baseline of holding the stocks for a year.
The second mode, action mode, has the additional requirement that the final day in the data must be a Thursday. It recommends stock options for long puts and calls.
After making changes to the model and/or adding new columns from the scraper the verification needs to run again.


# Folder structure information

## Tree
```
.
├─ Code
│   ├─ getClosingStocks.ipynb
│   ├─ stockPicker.ipynb
│   └─ Data
│       └─ raw
│           └─ yahoo
└─ README.txt
```

## Description

This is the description of the files from the tree.

Folder/File | Description
--- | --- 
getClosingStocks.ipynb	|  Portion of the code dealing with the webscraping 
stockPicker.ipynb	|  Data science portion containing the LSTM algorithm used for the actual predictions
Data			|  Used to contain subfolders which hold scrapped CSV files
raw			|  Used to contain CSV files from Nasdaq, which the Yahoo CSVs are appended to.
yahoo			|  Used to contain CSV files scrapped from Yahoo! Fiance
README.txt		|  This readme file (talk about recursion...)